[LWRP/URP]] documentation and API for Post-processing stack v2 effects

Retro Look Pro is a Post processing effect. It emulates screen bleeding , artefacts , tape noise , interlacing, shake, glitches and other effects. It is the best and complete solution for retro like games, 80's/90's/Retro/VHS/Glitch/TV look, security cameras or robotic eyes.

========

SRP support

Unity Editor version	Standard	LWRP	URP	HDRP
2017.4+	✔	✖	✖	✖
2018.4+	✔	✔	✖	✖
2019.3+	✔	✔	✔	✔
2020.1+	✔	✔	✔	✔

(LWRP&URP) Retro Look pro includes custom Post-processing effects pack for Post-processing stack v2

LWRP: full support of Lightweight Render Pipeline.

URP: Unity Editor 2019.3+ support Post-processing stack v2 in Universal Render Pipeline v7.2.1+ . When the PPv2 package is installed, you'll find a new option in the URP Asset to switch from integrated post-processing to PPv2 . https://github.com/Unity-Technologies/ScriptableRenderPipeline/pull/5354

NOTE: Retro Look pro LWRP Example scenes won't work in URP. Use Retro Look pro effects in your own project.

(HDRP) Retro Look pro includes custom Post-processing effects pack for HDRP integrated post-processing system.

HDRP: full support of High definition Render Pipeline from 7.1.1 version. Unity Editor version should be 2019.3+

========

Setup NEW Effects fot Post processing stack v2.

Source: https://docs.unity3d.com/Packages/com.unity.postprocessing@2.3/manual/Installation.html

To use new effects collection make sure that you installed "Post processing" package from package manager (Window/Package Manager) !

If you use Unity 2017, use your Git client to clone the post-processing repository into your Assets folder. https://github.com/Unity-Technologies/PostProcessing

Import "LWRP&URP&Standard Renderer RLPro" from "Assets/LimitlessUnityDevelopment/RetroLookPro" folder.

to setup Post processing stack v2 use this instructions https://docs.unity3d.com/Packages/com.unity.postprocessing@2.1/manual/Quick-start.html

In post process volume/profile click Add Effect/Retro Look Pro/"needed effect".

IMPORTANT NOTE : To use presets please open "\Assets\LimitlessUnityDevelopment\RetroLookPro\Resources\ColormapPresets.unitypackage" and import it. Then fill RetroLookProColorPaletePresetsList\presetslist with all presets from "\Assets\LimitlessUnityDevelopment\RetroLookPro\Resources\Colormap Presets".

========

Manipulating effects variables from PP2 version of Retro look pro

https://docs.unity3d.com/Packages/com.unity.postprocessing@2.0/manual/Manipulating-the-Stack.html

========

Variables :

========

NTSC Encode effect

Type	Name	Description
float	blur	blur. [0.01,2]
float	brightness	brightness. [1,40]
float	lineSpeed	Floating lines speed. [0,10]

========

Analog TV noise effect

Type	Name	Description
bool	staticNoise	Option enables static noise (without movement).
bool	Horizontal	Horizontal/Vertical Noise lines.
float	Fade	Effect Fade. [0,1]
float	barWidth	Noise bar width. [0,60]
vector2	tile	Noise tiling.
float	textureAngle	Noise texture angle. [0,1]
float	edgeCutOff	Noise bar edges cutoff. [0,100]
float	CutOff	Noise cutoff. [-1,1]
float	barSpeed	Noise bars speed. [-10,10]
texture2D	texture	Noise texture.

========

CRT Aperture effect

Type	Name	Description
float	GlowHalation	Glow Halation. [0,5]
float	GlowDifusion	Glow Difusion. [0,2]
float	MaskColors	Mask Colors. [0,5]
float	MaskStrength	Mask Strength. [0,1]
float	GammaInput	Gamma Input. [0,5]
float	GammaOutput	Gamma Output. [0,5]
float	Brightness	Brightness. [0,2.5]

========

Custom Texture

Type	Name	Description
texture	texture	Сustom texture.
float	fade	Fade parameter. [0,1]

========

Low Resolution effect

Type	Name	Description
float	pixelsize	pixel size. [1,20]

========

Phosphor tube noise effect

Type	Name	Description
float	width	width. [0,20]
float	amount	amount. [0,1]
float	fade	fade. [0,1]

========

Ultimate vignette effect

using RetroLookPro.Enums; - needed

Type	Name	Description
enum	vignetteShape	circle = 0; roundedCorners = 1
float	center	Circle center(parameter for vignetteShape = 0).
float	vignetteAmount	Vignette amount.
float	vignetteFineTune	Neat adjustment.
float	edgeSoftness	edge softness.
float	edgeBlend	blent edges with image.
float	innerColorAlpha	edges inner color alpha.
Color	innerColor	inner color.

========

Scanlines effect

Type	Name	Description
float	scanLinesColor	scanlines color
float	scanLines	scanLines width.
float	speed	scanlines speed.
bool	horizontal	Horizontal/Vertical scanlines.
float	distortion	horizontal interlacing.
float	distortion1	Warp.
float	distortion2	Cubic distortion.
float	scale	scale center of scanlines.
float	fade	effect fade.[0,1]

========

OldFilm effect

Type	Name	Description
float	fps	effect frames per second. [0, 60]
float	contrast	contrast. [0, 5]
float	burn	image burn.[-2,4]
float	sceneCut	negative amount.[0,16]
float	fade	effect fade.[0,1]

========

Warp effect

using RetroLookPro.Enums; - needed

Type	Name	Description
float	fade	effect fade. [0, 1]
enum	warpMode	Simple warp; Cubic distortion.
float	warp	Warp image corners on x/y axes.
float	scale	Warp picture center.

========

Negative effect

Type	Name	Description
float	luminosity	brightness. [0, 2]
float	vignette	vignette amount. [0, 1]
float	negative	negative amount.[0,1]

========

Glitch1

Type	Name	Description
float	amount	Effect amount. [0, 20]
float	stretch	noise stretch amount. [0, 4]
float	speed	noise speed. [0, 1]
float	fade	effect fade. [0,1]
float	rMultiplier	Red color offset muliplier. [-1, 2]
float	gMultiplier	Green color offset muliplier. [-1, 2]
float	bMultiplier	Blue color offset muliplier. [-1, 2]
float	x	X parameter of random value on noise texture. [-2, 127.1]]
float	y	Y parameter of random value on noise texture. [-2, 43758.5453123]
float	angleY	Angle Y parameter of random value on noise texture. [-2f, 311.7]
bool	mask	enables effect areas masking with texture
texture	maskTexture	mask texture ( uses textures alpha chanel. alpha = 0 - no effect).

========

Glitch2

Type	Name	Description
float	intencity	noise stretch amount. [0, 1]
float	resolutionMultiplier	glitch blocks height.(changes applies on enter in play mode) [1, 2]
float	stretchMultiplier	glitch blocks width.[0,1]

========

Glitch3

Type	Name	Description
float	speed	glitch speed.
float	density	glitch amount
float	maxDisplace	glitch max offset
bool	mask	enables effect areas masking with texture
texture	maskTexture	mask texture ( uses textures alpha chanel. alpha = 0 - no effect).

========

Bottom Noise

Type	Name	Description
float	height	Height of Stretch/Noise. [0, 0.5]
float	intencity	Noise intensity. [0, 3]
Texture	noiseTexture	Noise texture.
vector2	tile	Noise tiling.

========

Bottom Stretch

Type	Name	Description
float	height	Height of Stretch/Noise. [0.01, 0.5]
bool	distort	distort stretched area. []
float	frequency	Distortion frequency. [100, 0.1]
float	amplitude	Distortion amplitude. [0.01f, 200f]
bool	distortRandomly	enable random amplitude and frequency

========

Cinematic bars

Type	Name	Description
float	amount	amount of black bars. [0.5, 0.01]
float	fade	fade effect. [0,1]

========

Color Palette

Type	Name	Description
ResolutionMode	resolutionMode	The resolution of the pixelated image can be set in two ways.Either by setting absolute values (ConstantResolution) or by setting the pixel size (ConstantPixelSize).
Vector2Int	resolution	Change Resolution manually if using resolutionModeIndex - 0.
int	pixelSize	Change pixel size if using resolutionModeIndex - 1, in this case resolution calculates automatically. [1, 256]
float	dither	Dithering effect. [ 0 , 1]
float	opacity	Effect opacity. [0, 1]
int	presetIndex	Palette preset index number in palette presets list.
texture	bluenoise	Dither texture

========

TV effect

 using RetroLookPro.Enums; - needed

Type	Name	Description
float	fade	fade effect. [0, 1]
float	hardScan	Dark areas fine tune. [-8, -16]
float	resScale	Effect resolution. [16, 1]
enum	warpMode	Simple warp; Cubic distortion.
float	hardPix	pixels sharpness. [-3, 1]
float	maskDark	Dark areas adjustment. [0, 2]
float	maskLight	Light areas adjustment. [0, 2]
float	warp	Warp image corners on x/y axes.
float	scale	Warp picture center.

========

VHS effect

using RetroLookPro.Enums; - needed

Type	Name	Description
float	colorOffset	Amount of RGB shift. [0,50]
float	colorOffsetAngle	RGB shift angle Offset Angle. [-3,3]
float	verticalOffsetFrequency	Vertical twitch frequency. [0, 100]
float	verticalOffset	Amount of vertical twitch. [0, 1]
float	offsetDistortion	Amount of horizontal distortion. [0,0.5]
Texture	noiseTexture	Noise texture.
enum	blendMode	Photoshop like blendingModes. [21 modes]
Vector2	tile	Noise texture.
float	_textureIntensity	Intensity of noise texture. [0, 1]
bool	smoothCut	enables smooth Cut. [0, 1]
float	iterations	blur iterations. [0, 30]
float	smoothSize	smooth Size. [0, 0.5]
float	deviation	deviation. [0, 0.5]
float	_textureCutOff	Intensity of noise texture. [-1, 1]
float	stripes	Cinematic black bars. Low value of this parameter is very usefull in pair with vertical offset [0.01,0.5]
bool	unscaledTime	Time.unscaledTime.

========

Bleed effect

Type	Name	Description
int	bleedMode	Bleed Mode index. 0 - "Old Three Phase" 1 - "Three Phase" 2 - "Two Phase" 3 - "Custom".
float	bleedAmount	Bleed Stretch amount. [0, 15]
int	bleedLength	Bleed Length [0, 50]. If b_Mode = 3
bool	editCurves	Enable this to edit curves and see result instantly (otherwise result will be applied after you enter playmode) .
bool	syncYQ	Synchronize Y and Q chanels.
AnimationCurve	curveY	Curve Y chanel.
AnimationCurve	curveI	Curve I chanel.
AnimationCurve	curveQ	Curve Q chanel.

========

Fisheye effect

Type	Name	Description
float	bend	Bend Amount. [0, 50]
int	fisheyeType	Fisheye type index. 0 - "Default", 1 - "Hyperspace".
float	size	Fisheye size. [0, 50]
float	cutOffX	Cutoff on X axes. [0, 50]
float	cutOffY	Cutoff on Y axes. [0, 50]
float	fadeX	Fade on X axes. [0, 50]
float	fadeY	Fade on Y axes. [0, 50]

========

Pulsating Vignette effect

Type	Name	Description
float	amount	Amount of vignette effect. [0, 5]
float	speed	Vignette blinking speed. [0, 5]

========

Noise

Type	Name	Description
float	stretchResolution	resolution.
float	n_NoiseLinesAmountY	Amount of noise lines on Y axes.
float	n_NoiseSignalProcessing	Noise Signal Processing Amount. [0, 1]
bool	f_Granularity	Enable granularity noise effect.
float	f_GranularityAmount	Granularity Alpha. [0, 0.1]

Signal Noise

Type	Name	Description
bool	f_SignalNoise	Enable signal noise.
float	f_SignalNoiseAmount	Signal amount. [0, 1]
float	f_SignalNoisePower	Signal power. [0, 1]

Tape Noise

Type	Name	Description
bool	f_TapeNoise	Enable tape noise.
float	f_TapeNoiseTH	Tape Amount. [0, 1.5]
float	f_TapeNoiseAmount	Tape alpha. [0, 1.5]
float	f_TapeNoiseSpeed	Tape speed. [0, 1.5]
float	n_NoiseSignalProcessing	Tape Noise processing value. [0,15]

Line Noise

Type	Name	Description
bool	f_LineNoise	Enable line noise.
float	f_LineNoiseAmount.	Amount of line noise. [0, 10]
float	f_LineNoiseSpeed	Noise speed. [0, 10]
bool	unscaledTime	Time.unscaledTime.
bool	mask	enables effect areas masking with texture
texture	maskTexture	mask texture ( uses textures alpha chanel. alpha = 0 - no effect).

========

Video Shake filter

Jitter

Type	Name	Description
bool	stretch	Enable stretch noise.
float	stretchResolution	Stretch resolution. []
bool	jitterHorizontal	Enable Horizontal Interlacing.
float	jitterHorizontalAmount	Amount of horizontal interlacing. [0, 5]
bool	jitterVertical	Shake Vaertical.
float	jitterVerticalAmount	Amount of shake. [0, 15]
float	jitterVerticalSpeed	Speed of vertical shake. [0, 5]

Twitch

Type	Name	Description
bool	twitchHorizontal	Enable Twitch on X axes.
float	horizontalFreq	Twitch frequency on X axes. [0, 5]
bool	twitchVertical	Enable Twitch on Y axes.
float	verticalFreq	Twitch frequency on Y axes. [0, 5]
float	twitchVerticalInterval	Twitch interval on Y axes.[0,25]
bool	unscaledTime	Time.unscaledTime .

========

Picture correction

Type	Name	Description
float	signalAdjustY	Y permanent adjustment. [-0.25, 0.25]
float	signalAdjustI	I permanent adjustment. [-0.25, 0.25]
float	signalAdjustQ	Q permanent adjustment. [-0.25, 0.25]
float	signalShiftY	tweak/shift Y values. [-2, 2]
float	signalShiftI	tweak/shift I values. [-2, 2]
float	signalShiftQ	tweak/shift Q values. [-2, 2]
float	gammaCorection	use this to balance the gamma(brightness) of the signal. [0, 2]

========

Artefacts

Type	Name	Description
float	cutOff	Brightness threshold of input. [0, 1]
float	amount	Amplifies the input amount after cutoff. [0, 3]
float	fade	Value represents how fast trail fades. [0, 1].
Color	color	Artefacts color.